PATCH
/
v2
/
offsite-ads
/
campaigns
/
{campaign_id}
curl --request PATCH \
  --url https://api.topsort.com/v2/offsite-ads/campaigns/{campaign_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "budget": 123,
  "endDate": "2023-11-07T05:31:56Z",
  "geotargetingIds": [
    "<string>"
  ],
  "name": "<string>",
  "productIds": [
    "<string>"
  ],
  "startDate": "2023-11-07T05:31:56Z",
  "status": "ENABLED"
}'
{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
campaign_id
string
required

The unique identifier of the campaign.

Body

application/json
​
budget
integer

Optional new budget for the campaign.

​
endDate
string

Optional new end date for the campaign.

​
geotargetingIds
string[]

Optional new list of geotargeting IDs.

​
name
string

Optional new name for the campaign.

​
productIds
string[]

Optional new list of product IDs.

​
startDate
string

Optional new start date (cannot be changed for started campaigns).

​
status
enum<string>
Available options:
ENABLED,
PAUSED,
REMOVED

Response

202
application/json
Successful Response
​
jobId
string
required

The unique identifier for the queued job.